home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archivers / XpkArchPackage / XArcTool.doc < prev    next >
Text File  |  1996-09-26  |  9KB  |  249 lines
  1.  
  2.  
  3.                             XArcTool V1.4
  4.                             =============
  5.  
  6.                        © 1994 by Matthias Meixner
  7.  
  8.  
  9.  
  10.                             Introduction
  11.                             ------------
  12. XArctool is a graphical userinterface for the xpkarchive.library. It allows
  13. you to handle archives similar to directory-utilities like opus. You can
  14. add files to archives, extract files from them and copy files between
  15. different archives without decompression/compression. Furthermore it allows
  16. you to copy files from one directory to another just like a normal
  17. directory-utility. What's new is the ability to rename files within archives
  18. and add filenotes to files within an archive. You can modify the
  19. protectionflags of files and keep track of different versions of one file
  20. within the archives. In fact all these abilities are offered by the
  21. xpkarchive.library and XArcTool is just a comfortable userinterface to the
  22. abilities of this library. If you want to use these functions yourself read
  23. the docs of the xpkarchive.library that comes with this package.
  24. XArcTool is fontsensitive up to a certain degree as long as the size of the
  25. font is not too large for the selected size of the window. However if you
  26. select a very large font and select very small windowdimensions the layout
  27. will get messed up, but the program still should work fine.
  28.  
  29.  
  30.                             License/Disclaimer
  31.                             ------------------
  32.  
  33. XArcTool (C) Copyright 1994 by Matthias Meixner.  All rights reserved.
  34.  
  35.  This program is GIFTWARE which means that if you like the program you
  36.  should reward the author with a gift that, you think, matches his efforts.
  37.  
  38.    This Program may be freely distributed with the XPK compression
  39.  package, as long as it is kept in its original, complete, and unmodified
  40.  form.  It may not be distributed by itself or in a commercial package of
  41.  any kind without my written permission. This also means the distribution
  42.  on cover disks, disk magazines etc. Fred Fish may include this program on
  43.  his AmigaLibDisk series.
  44.  
  45.   This program is distributed in the hope that it will be useful, but
  46. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  47. or FITNESS FOR A PARTICULAR PURPOSE.
  48.  
  49.  
  50.  
  51.  
  52.  
  53.                           Getting started
  54.                           ---------------
  55. First install the xpkarchive.library by doubleclicking on the
  56. "Install_Lib"-icon, then simply drag the whole drawer to a location on
  57. your harddisk.
  58.  
  59. CLI-USAGE:
  60.  
  61. XArcTool PATH/M,P=PACKER/K,M=MODE/N,PW=PASSWD/K,L=LEFT/N,T=TOP/N,W=WIDTH/N,
  62.          H=HEIGHT/N,I=ICON/S
  63.  
  64. Option:     Effect:
  65.  
  66. PATH/M      Allows you to select the two paths, that XArcTool uses. They may
  67.             be also archives, that should be entered.
  68.  
  69.             e.g.   XArctool ram: hd0:
  70.  
  71. P=PACKER    selects the default packer
  72.  
  73. M=MODE      selects the default packmode
  74.  
  75. PW=PASSWD   selects the default password for encryption
  76.  
  77. L=LEFT,
  78. T=TOP,
  79. W=WIDTH,
  80. H=HEIGHT    selects the position and dimensions of XArcTool's window
  81.  
  82. I=ICON      cause XArcTool to generate icons for archives.
  83.  
  84. Additional example:
  85.  
  86.        XArcTool P=FEAL M=100 PW=test ICONS ram:
  87.  
  88.        Will cause XArcTool to use FEAL with mode 100 and password "test" as
  89.        default. The path of the left directorylist will be "ram:"
  90.  
  91.  
  92. WB-USAGE:
  93.  
  94. WB offers the same options as available from CLI, just add one line
  95. per option in the tooltypes in the icon. You can feature the PATH
  96. option by using multiple selection from workbench: click once on XArcTool,
  97. then once on the first directory and then doubleclick the icon of the second
  98. directory. Very useful in this context are the LEFT,TOP,WIDTH and HEIGHT
  99. options which allow you to customize the size of XArcTool's window via the
  100. tooltypes.
  101.  
  102.  
  103.  
  104.  
  105.                         Using XArcTool
  106.                         --------------
  107.  
  108. When XArcTool opens up its window you will see two directorylists, one on
  109. the left and one on the right side. The stringadgets above represent the
  110. pathname of the directories that are displayed, where the upper one gives
  111. the pathname on disk and the lower one gives you the pathname within an
  112. archive if you have selected an archive in the upper path. The arrow between
  113. the two pathgadgets define the direction of the copy command and by this it
  114. defines the source- and destinationdirectories. All other actions refer to
  115. the sourcedirectory.
  116. Archives are handled similar to normal directories, just that additional
  117. actions will take place. That is if you copy a file from a normal directory
  118. to an archive the file will be compressed. If you copy the other way round
  119. the file will be decompressed. Copying from one archive to another will not
  120. affect the compression, it does not decompress and recompress the file and
  121. is therefore quite fast.
  122.  
  123. Creating archives or directories:
  124. If you type a path that does not exist yet, you are prompted if you want to
  125. create this object as a directory or as an archive. By this you can create
  126. new archives. Archives will get the fileextension ".xar".
  127.  
  128. Copying/compressing/decompressing files:
  129. Select the files by clicking on the corresponding lines in the directorylist
  130. or using one of the "tag" menus and click on the gadget "Copy". Depending on
  131. the selected path/archivenames the file will (de)compressed or just be
  132. copied. You can enter directories or archives, by doubleclicking on these
  133. erntries in the directorylists.
  134.  
  135. Renaming of files:
  136. Select the files and click on "Rename". A requester will pop up and ask you
  137. to enter the new name and if the file resides within an archive the new
  138. generationnumber. You can recover files within archives that have been
  139. deleted but not yet removed with the pack function by setting the
  140. generationnumber to a value different from 256. You may rename directories
  141. as well as files.
  142. (See also information on generations)
  143.  
  144. Deleting files:
  145. "Delete" deletes the seleted files, if they are within a normal directory
  146. or marks them as deleted if they are within an archive. They are physically
  147. removed by using the "Pack"-function.
  148.  
  149. Setting filenotes:
  150. "Filenote" enables you to set/remove filenotes. Removing a filenote is done
  151. by deleting the string from the stringgadget of the requester that asks you
  152. for the new filenote.
  153.  
  154. Changing the fileprotection:
  155. "Protect" will open a requester for any selected file and enables you to
  156. enter the new protectionflags via some buttons.
  157.  
  158. Packing archives:
  159. "Pack" will remove all files that have been marked as deleted and removes
  160. some information, that has been added for the renaming of files and setting
  161. of filenotes. After you have packed an archive it is no longer possible to
  162. recover deleted files from an archive.
  163.  
  164. "Options" allows you to select a new packer-sublibrary and mode and allows
  165. you to enter the password if you have selected an encryptionlibrary.
  166.  
  167. "Parent" gets the parent-directory of the sourcedirectory.
  168.  
  169. "Get" rereads the contents of the sourcedirectory.
  170.  
  171. The listview below the "Get" gadget allows you to select a new volume for
  172. the sourcedirectory.
  173.  
  174. Other Gadgets:
  175. The scrollers are used to, hmm, scroll around :-)
  176.  
  177. "Sync"-Gadget:
  178. This one is a useful thing. If activated changes to the path either by
  179. double-clicking on a directory or via the "parent"-gadget are applied to
  180. both paths. This allows the easy duplication of complete directorytrees.
  181.  
  182.  
  183. Menus:
  184. ------
  185.  
  186. Project
  187.    Quit:        quit XArcTool
  188.  
  189. Specials:
  190.    Tag all:     mark all files within the sourcedirectory as selected
  191.    Tag Pattern: mark all files that match a pattern in the sourcedirectory
  192.                 as selected
  193.  
  194.    Untag all
  195.    Untag Pattern : Like the "Tag" functions, just that they mark the files
  196.                    as deselected.
  197.  
  198.  
  199.  
  200.                            What XArcTool displays
  201.                            ----------------------
  202. XArcTool displays the following information in its directorylists:
  203.  
  204. For normal directories (in this order):
  205. filename filesize protectionflags date&time filenote
  206.  
  207. For archives:
  208. filename generationnumber (compressed size) uncompressed size packer
  209.                   protectionflags date&time filenote
  210.  
  211.  
  212.  
  213.  
  214.                                Generations
  215.                                -----------
  216. xpkarchive.library is able to keep more than one version of every file (like
  217. e.g. zoo). These files have exact the same filename, but they differ in the
  218. generationnumber. A generationnumber of 256 marks the file as deleted.
  219. xpkarchive.library tries to keep track of the versionnumber, e.g. if you add
  220. a file, that already exists in the archive, the generationnumber of this file
  221. will be increased and the new file will get the genreationnumber of 1.
  222.  
  223.  
  224.                                 History
  225.                                 -------
  226. 1.4: used SetWindowPointer under V37, which exists only since V39, fixed
  227.  
  228. 1.3: first public release
  229.  
  230.  
  231.  
  232. TODO:
  233.  
  234. Write a better documentation :-)
  235.  
  236.  
  237. If you find bugs, have questions or ??? write to:
  238.  
  239.    Matthias Meixner
  240.    Sandberg 13
  241.    36145 Schwarzbach
  242.    06684/840
  243.  
  244. EMail:
  245.    meixner@rbg.informatik.th-darmstadt.de
  246.  
  247.  
  248.  
  249.